Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix small logical mistake in automation rules examples #19415

Merged
merged 3 commits into from
Jun 20, 2022
Merged

Fix small logical mistake in automation rules examples #19415

merged 3 commits into from
Jun 20, 2022

Conversation

ityankel
Copy link
Contributor

@ityankel ityankel commented Jun 12, 2022 •
edited
Loading

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify - fix small logical mistake in the examples for last 2 API versions so that the example will match the intended scenario
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @ityankel Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    1 similar comment
    @openapi-workflow-bot
    Copy link

    Hi, @ityankel Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 12, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 12, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go-track2 - armsecurityinsights - 2.0.0-beta.2
    ❌azure-sdk-for-python-track2 - track2_azure-mgmt-securityinsight - 1.0.0b2
    ❌azure-sdk-for-js - @azure/arm-securityinsight - 1.0.0-beta.4
    ️❌ azure-sdk-for-net failed [Detail]   
  
    • ❌Failed [Logs]Release - Generate from 8f19637. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-6.0
command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/securityinsights/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]   
  
    • ⚠️Warning [Logs]Release - Generate from 8f19637. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]  config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-securityinsight        [View full logs]         [Release SDK Changes]        Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group SecurityMLAnalyticsSettingsOperations
info	[Changelog]   - Model DataConnectorConnectBody has a new parameter data_collection_endpoint
info	[Changelog]   - Model DataConnectorConnectBody has a new parameter data_collection_rule_immutable_id
info	[Changelog]   - Model DataConnectorConnectBody has a new parameter output_stream
info	[Changelog]   - Model EntityAnalytics has a new parameter entity_providers
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model EntityAnalytics no longer has parameter is_enabled
    ️⚠️ azure-sdk-for-js warning [Detail]   
  
    • ⚠️Warning [Logs]Release - Generate from 8f19637. SDK Automation 14.0.0 
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh]  deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  WARN deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-securityinsight        [View full logs]         [Release SDK Changes]        Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation group SecurityMLAnalyticsSettings
info	[Changelog]   - Added Interface AutomationRulePropertyArrayChangedValuesCondition
info	[Changelog]   - Added Interface AutomationRulePropertyValuesChangedCondition
info	[Changelog]   - Added Interface GetInsightsErrorKind
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsCreateOrUpdateOptionalParams
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsDataSource
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsDeleteOptionalParams
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsGetOptionalParams
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsList
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsListNextOptionalParams
info	[Changelog]   - Added Interface SecurityMLAnalyticsSettingsListOptionalParams
info	[Changelog]   - Added Type Alias AnomalySecurityMLAnalyticsSettings
info	[Changelog]   - Added Type Alias AnomalyTimelineItem
info	[Changelog]   - Added Type Alias AutomationRulePropertyArrayChangedConditionSupportedArrayType
info	[Changelog]   - Added Type Alias AutomationRulePropertyArrayChangedConditionSupportedChangeType
info	[Changelog]   - Added Type Alias AutomationRulePropertyChangedConditionSupportedChangedType
info	[Changelog]   - Added Type Alias AutomationRulePropertyChangedConditionSupportedPropertyType
info	[Changelog]   - Added Type Alias EntityProviders
info	[Changelog]   - Added Type Alias Enum13
info	[Changelog]   - Added Type Alias GetInsightsError
info	[Changelog]   - Added Type Alias PropertyArrayChangedConditionProperties
info	[Changelog]   - Added Type Alias PropertyChangedConditionProperties
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSetting
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingsCreateOrUpdateResponse
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingsGetResponse
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingsKind
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingsListNextResponse
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingsListResponse
info	[Changelog]   - Added Type Alias SecurityMLAnalyticsSettingUnion
info	[Changelog]   - Added Type Alias SettingsStatus
info	[Changelog]   - Interface DataConnectorConnectBody has a new optional parameter dataCollectionEndpoint
info	[Changelog]   - Interface DataConnectorConnectBody has a new optional parameter dataCollectionRuleImmutableId
info	[Changelog]   - Interface DataConnectorConnectBody has a new optional parameter outputStream
info	[Changelog]   - Class SecurityInsights has a new parameter securityMLAnalyticsSettings
info	[Changelog]   - Type Alias EntityAnalytics has a new parameter entityProviders
info	[Changelog]   - Added Enum KnownAutomationRulePropertyArrayChangedConditionSupportedArrayType
info	[Changelog]   - Added Enum KnownAutomationRulePropertyArrayChangedConditionSupportedChangeType
info	[Changelog]   - Added Enum KnownAutomationRulePropertyChangedConditionSupportedChangedType
info	[Changelog]   - Added Enum KnownAutomationRulePropertyChangedConditionSupportedPropertyType
info	[Changelog]   - Added Enum KnownEntityProviders
info	[Changelog]   - Added Enum KnownEnum13
info	[Changelog]   - Added Enum KnownGetInsightsError
info	[Changelog]   - Added Enum KnownSecurityMLAnalyticsSettingsKind
info	[Changelog]   - Added Enum KnownSettingsStatus
info	[Changelog]   - Enum KnownConditionType has a new value PropertyArrayChanged
info	[Changelog]   - Enum KnownConditionType has a new value PropertyChanged
info	[Changelog]   - Enum KnownEntityTimelineKind has a new value Anomaly
info	[Changelog]   - Enum KnownTriggersWhen has a new value Updated
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Type Alias EntityAnalytics no longer has parameter isEnabled
info	[Changelog]   - Type Alias Watchlist no longer has parameter sasUri
info	[Changelog]   - Type Alias Watchlist no longer has parameter provisioningState
info	[Changelog]   - Removed Enum KnownEnum12
info	[Changelog]   - Removed Enum KnownProvisioningState
info	[Changelog]   - Removed Enum KnownSkuKind
    ️⚠️ azure-sdk-for-java warning [Detail]   
  
    • ⚠️Warning [Logs]Release - Generate from 8f19637. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-securityinsights        [View full logs]         [Release SDK Changes]      
    ️⚠️ azure-resource-manager-schemas warning [Detail]   
  
    • ⚠️Warning [Logs]Release - Generate from 8f19637. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation
    • ️✔️securityinsights        [View full logs]       
    ️❌ azure-powershell failed [Detail]   
  
    • ❌Failed [Logs]Release - Generate from 8f19637. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ❌Az.securityinsights        [View full logs]         [Release SDK Changes]      
    Posted by Swagger Pipeline | How to fix these errors?
          		
    
    
      

    
    


        
    

            

            
    
              
            
    
        
    
      
    

      
    
            
  
    
    
  
    
    

  
    
  
    


        
    

    


    



    


      
    
  
          
    
  
    
    
  
    

  
    
      
    
  This was referenced Jun 12, 2022

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



  
    

    

    


  
    
  
    
    
  
    

  
    
      
    
  This was referenced Jun 12, 2022

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



  
    

    

    


  
    
  
  
    
  
          @ityankel
  ityankel


        marked this pull request as ready for review

    
      June 12, 2022 07:42
    
    

    

    
    





    

      
    
  
      

    

  
    
  @ityankel


    


  
    

    
    
      
    
  
    
    
    
        
    
    

  


      
          
  
      
            Copy link

  
    
              
    
    
  
    

  
    
      

  
    Contributor


      

  Author


  
    

  
    
    

  
    

    


      
    

        

    
  
    
    
      
          
    Reviewer, I saw the breaking change checks failed but it seems to me that it's unrelated to my changes since I only modified some automation rules example files and the breaking change errors are about some EntityAnalytics models in a different resource type
    
          		
    
    
      

    
    


        
    

            

            
    
              
            
    
        
    
      
    

      
    
            
  
    
    
  
    
    

  
    
  
    


        
    

    


    



    


      
    
  
      

    

  
    
  @dw511214992


    


  
    

    
    
      
    
  
    
    
    
        
    
    

  


      
          
  
      
            Copy link

  
    
              
    
    
  
    

  
    
      

  
  Member


      

  
    

  
    
    

  
    

    


      
    

        

    
  
    
    
      
          
    @ityankel Don't worry. The sdk breaking change is generated by comparing released sdk and latest generated codes. It's not caused by your change.
    
By the way, do you want  to merge this PR?
    
          		
    
    
      

    
    


        
    

            

            
    
              
            
    
        
    
      
    

      
    
            
  
    
    
  
    
    

  
    
  
    


        
    

    


    



    


      
    
  
      

    

  
    
  @ityankel


    


  
    

    
    
      
    
  
    
    
    
        
    
    

  


      
          
  
      
            Copy link

  
    
              
    
    
  
    

  
    
      

  
    Contributor


      

  Author


  
    

  
    
    
    
      

      
            ityankel
  

      

      

      commented


        Jun 15, 2022


      
  •

  
    
    
      
    
        
          edited
          
        
        
      
    
        
    
      
        
      Loading

      
    
  
    
    

    
    

  
    

    


      
    

        

    
  
    
    
      
          
    

    @ityankel Don't worry. The sdk breaking change is generated by comparing released sdk and latest generated codes. It's not caused by your change. By the way, do you want to merge this PR?
    

    

    @dw511214992
    
Ok, thanks.
    
And yes, please merge it. We want the examples that customers can see to be correct logically for real use cases, and not just match the swagger schema
    
          		
    
    
      

    
    


        
    

            

            
    
              
            
    
        
    
      
    

      
    
            
  
    
    
  
    
    

  
    
  
    


        
    

    


    



    


      
    
  
        



    

      
    
  
        



    

      
    
  
          
    
  
    
    
  
    
  
    


        @dw511214992
  dw511214992



        merged commit 8f19637
      into

      
  
    Azure:main
  


    Jun 20, 2022

  
    

    


    

  
    
  
    
    
  
    

  
    
      
    
  This was referenced Jun 20, 2022

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



      
    

    


    
  


  
    
      
   Closed

  
    

    



  
    

    

  
  
  
    
  
  
    
  
          @ityankel
  ityankel


    
    deleted the
    
      
        feature/ityankel/fixAutomationExample
    
    branch

    
      March 3, 2024 12:21
    
    

    

    



    





  
  
    
    
    
      

      
    



    
    

    
    
      
    
              
    
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment


  

    

      
    
    
    
  
    


    
  
              

    


      
    
  
    
    
    
    
    
  
    
    Reviewers
  
    

    


        
    
          

  
      @dw511214992
  
    dw511214992



          
            
              
            
          
          dw511214992 approved these changes

        
    

      
    


    


    
    
  
    

      
  
    
    Assignees
  
    


        

      
    
        

  
      @dw511214992
  
    dw511214992
    

      
    
    



    


      

    
  


  
    
    Labels
  
    


    
    
      

    CI-BreakingChange-JavaScript



    


    


      

  
    
    
    
        
    
    Projects
  
    

        
    

    

    None yet




      
    


      

    
  
    
    
  
    
    Milestone
  
    

      No milestone


    


    
      
          

    
  
    
    
      
    
        
    
    
    Development
  
    


          


    Successfully merging this pull request may close these issues.
    


  


            
  
    

    

        
          

    

  
      
    
  
    
    
    
      2 participants
    
    
    
    
        
          @ityankel 
        
          @dw511214992